/*
 *  NASA Docket No. GSC-18,370-1, and identified as "Operating System Abstraction Layer"
 *
 *  Copyright (c) 2019 United States Government as represented by
 *  the Administrator of the National Aeronautics and Space Administration.
 *  All Rights Reserved.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

/**
 * \file
 *
 * Purpose: This file contains functions to implement a standard way to execute unit tests.
 */

#ifndef UTGLOBAL_H
#define UTGLOBAL_H

/*
 * Includes
 */
#include "osapi.h"
#include "utassert.h"
#include "utlist.h"
#include "utbsp.h"
#include "uttest.h"
#include "utstubs.h"

/*
 * Type Definitions
 */

typedef struct
{
    void (*Test)(void);
    void (*Setup)(void);
    void (*Teardown)(void);

    /* Note - the name entry should be long enough to support a GroupName.TestName pattern,
     * hence why it uses double the OS_MAX_API_NAME length */
    char TestName[OS_MAX_API_NAME * 2];
} UtTestDataBaseEntry_t;

typedef struct
{
    UtListHead_t *DataBasePtr;
    uint32        ExecutedCount;
} UtAssert_Global_t;

/*
 * Global Test Data
 */
extern UtAssert_Global_t UtAssert_Global;

#endif /* UTGLOBAL_H */
